← Tilbage til Hovedside

Overblik

Dette afsnit beskriver de tilgængelige REST-endpoints til søgning efter virksomhedsoplysninger og hentning af metadata om dokumenttyper og roller.

Den primære søgefunktionalitet gør det muligt at søge efter dokumenter relateret til en virksomhed ved hjælp af CVR-nummer med forskellige filtre. Yderligere endpoints leverer lister over tilgængelige dokumenttyper og rolletyper til brug i søgninger.

Endpoints

SoegVirksomhedCvr

Endpoint URL: soegvirksomhed/cvr

Method

GET

Beskrivelse

Søg efter dokumenter relateret til en virksomhed ved hjælp af CVR-nummer med valgfrie filtre for dokumenttype, rolle, datointerval og paginering.

Input

Query parametre:

  • cvr - CVR-nummer (påkrævet)

  • bog - Bognummer (1=Fast ejendom, 2=Køretøjer, 3=Andelsboliger, 4=Personer/virksomheder) (valgfri)

  • doktype - Dokumenttype (valgfri, standard: 'Pantebrev'). Se GetDokumenttyper.

  • rolle - Rolletype (valgfri). Se GetRolletyper.

  • datofra - Fra dato (valgfri)

  • datotil - Til dato (valgfri)

  • sidetal - Sidenummer til paginering (standard: 1)

  • antal - Antal resultater pr. side (standard: 25)

Output

JSON-svar indeholdende matchende dokumenter med virksomhedsoplysninger.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /soegvirksomhed/cvr?cvr=15231599&bog=1&doktype=Adkomst&rolle=debitor&datofra=01012000&datotil=01012020&sidetal=1&antal=25 HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

GetDokumenttyper

Endpoint URL: soegvirksomhed/dokumenttyper

Method

GET

Beskrivelse

Hent en liste over tilgængelige dokumenttyper, der kan bruges i virksomhedssøgninger.

Input

Ingen

Output

JSON-svar indeholdende en liste af dokumenttyper med nøgle-værdi-par og bognumre.

Fejlhåndtering

Standard HTTP fejlkoder ved manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /soegvirksomhed/dokumenttyper HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

GetRolletyper

Endpoint URL: soegvirksomhed/rolletyper

Method

GET

Beskrivelse

Hent en liste over tilgængelige rolletyper, der kan bruges i virksomhedssøgninger.

Input

Ingen

Output

JSON-svar indeholdende en liste af rolletyper med nøgle-værdi-par.

Fejlhåndtering

Standard HTTP fejlkoder ved manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /soegvirksomhed/rolletyper HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*

HarRegistreringer

Endpoint URL: soegvirksomhed/registreringer

Method

GET

Beskrivelse

Kontrollér om en virksomhed har registreringer i systemet. Kan valgfrit returnere resultatet som et PDF-dokument.

Input

Query parametre:

  • cvr - CVR-nummer (påkrævet)

  • sompdf - Returnér som PDF-dokument (standard: false)

Output

JSON-svar der angiver, om der findes registreringer, eller PDF-dokument hvis sompdf=true.

Fejlhåndtering

Standard HTTP fejlkoder ved ugyldigt input eller manglende adgang.

Interaktionsmønster

Forespørgsel-svar

Eksempel på forespørgsel:

GET /soegvirksomhed/registreringer?cvr=15231599&somPdf=false HTTP/1.1
host: nc-dev-xml-api.tinglysning.dk
accept: */*